XVI. Virtual Servers Commands

The vservers command node includes the following subnode commands:

  • routes

  • servers

Each of the subnode commands, and the leaf-node commands attached to them, is described in detail, with parameters and arguments listed for each command.

Examples of command usage are included in the discussions.

Table of Contents
Virtual Servers Routing Commands —
vservers routes delete — Use the vservers routes delete command to remove a static route from a virtual server.
vservers routes show — Use the vservers routes show command to display route configuration information about one or more virtual servers.
Virtual Servers Servers Commands —
vservers servers adddefaultgateway — Use the vservers servers adddefaultgateway command to add a default gateway address to a virtual server.
vservers servers addstaticroute — Use the vservers servers addstaticroute command to create a static route for a virtual server.
vservers servers bindif — Use the vservers servers bindif command to bind a virtual interface to a virtual server.
vservers servers delete — Use the vservers servers delete command to remove a virtual server from the network.
vservers servers modify — Use the vservers servers modify command to modify the configuration of a virtual server.
vservers servers new — Use the vservers servers new command to create a virtual server.
vservers servers newrootmirror — Use the vservers servers newrootmirror command to create a backup of a virtual server's root.
vservers servers offline — Use the vservers servers offline command to take offline all virtual interfaces bound to a virtual server.
vservers servers online — Use the vservers servers online command to bring online all virtual interfaces bound to a virtual server.
vservers servers show — Use the vservers servers show command to display configuration information about all virtual servers or information about one virtual server.
vservers servers unbindif — Use the vservers servers unbindif command to unbind a virtual interface from a virtual server.

Virtual Servers Routing Commands

Name

Virtual Servers Routing Commands -- 

The vservers routes subnode command includes the following leaf-node commands:


vservers routes delete

Name

vservers routes delete -- Use the vservers routes delete command to remove a static route from a virtual server.

Synopsis

CLI:

vservers routes delete -vsname virtual_server_name -nexthop nexthop_IP_address -netnumber network_IP_address -netmask netmask

GUI: Navigate to the Virtual Servers → Routing node, then select the appropriate route from the table and run the Delete command from the drop-down menu of the action pane.

Description

The vservers routes delete command identifies a virtual server by its virtual server name and removes its static route.

Options

-vsname virtual_server_name

This is the name of the virtual server.

-nexthop nexthop_IP_address

This is the next-hop IP address.

-netnumber network_IP_address

This is the network IP address.

-netmask netmask

This is the network IP mask.

Example

The following command example identifies a virtual server named Server1vserver1 and removes its route, which is defined as having a next-hop address of 10.1.1.104, a network address of 10.1.1.14, and a netmask of 255.255.255.0.

spinserver::> vservers routes delete -vsname Server1vserver1 -nexthop 10.1.1.104 -netnumber 10.1.1.14 -netmask 255.255.255.0

vservers routes show

Name

vservers routes show -- Use the vservers routes show command to display route configuration information about one or more virtual servers.

Synopsis

CLI:

vservers routes show [-vsname virtual_server_name -nexthop nexthop_IP_address -netnumber network_IP_address -netmask netmask]

GUI: Navigate to the Virtual Servers → Routing node. To display information about a specific route, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The vservers routes show command displays routing information about one virtual server or all virtual servers. To display route information about one route, use the command with all the parameters. To display route configuration information about a list of routes in the system, do not use the parameters. If one parameter is used, all other parameters must be specified. The command displays the following information about the virtual server or virtual servers:

Options

[-vsname virtual_server_name]

This is the name of the virtual server. This parameter is optional; however, if it is used, all other parameters must also be specified.

[-nexthop nexthop_IP_address]

This is the next-hop IP address. This parameter is optional; however, if it is used, all other parameters must also be specified.

[-netnumber network_IP_address]

This is the network IP address. This parameter is optional; however, if it is used, all other parameters must also be specified.

[-netmask netmask]

This is the network IP mask. This parameter is optional; however, if it is used, all other parameters must also be specified.

Example

The following command example displays route configuration information.

spinserver::> vservers routes show 
   Virtual Server    Default Gateway  Network Address    Network Mask   Metric
                         Address

Server1              10.3.0.3         0.0.0.0          0.0.0.0          1

Virtual Servers Servers Commands

Name

Virtual Servers Servers Commands -- 

The vservers servers subnode includes the following leaf-node commands:


vservers servers adddefaultgateway

Name

vservers servers adddefaultgateway -- Use the vservers servers adddefaultgateway command to add a default gateway address to a virtual server.

Synopsis

CLI:

vservers servers adddefaultgateway -vsname virtual_server_name -gateway gateway_IP_address

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Add Default Gateway command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Add Default Gateway.

Description

The vservers servers adddefaultgateway command adds a default gateway to a virtual server.

Options

-vsname virtual_server_name

This is the name of the virtual server.

-gateway gateway_IP_address

This is the gateway IP address.

Example

The following command example adds a gateway IP address of 10.1.1.104 to a virtual server named Server1vserver1.

spinserver::> vservers servers adddefaultgateway -vsname Server1vserver1 -gateway 10.1.1.104

vservers servers addstaticroute

Name

vservers servers addstaticroute -- Use the vservers servers addstaticroute command to create a static route for a virtual server.

Synopsis

CLI:

vservers servers addstaticroute -vsname virtual_server_name -gateway gateway_IP_address -netaddress network_IP_address -netmask netmask -metric metric 

GUI: Navigate to the Virtual Servers → Servers node, then select a virtual server from the table that is displayed and run the Add Static Route command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Add Static Route.

Description

The vservers servers addstaticroute command creates a static route for a virtual server.

Options

-vsname virtual_server_name

This is the name of the virtual server.

-gateway gateway_IP_address

This is the gateway IP address.

-netaddress network_IP_address

This is the network IP address.

-netmask netmask

This is the network IP mask.

-metric metric

This is the most economical route.

Example

The following command example adds a new static route to a virtual server named Server1vserver1. The route is defined with a gateway IP address of 10.1.1.104, a destination IP address of 10.1.1.14, a netmask of 255.255.255.0, and a metric of 1.

spinserver::> vservers servers addstaticroute -vsname Server1vserver1 -gateway 10.1.1.104 -netaddress 10.1.1.14 -netmask 255.255.255.0 -metric 1 

vservers servers bindif

Name

vservers servers bindif -- Use the vservers servers bindif command to bind a virtual interface to a virtual server.

Synopsis

CLI:

vservers servers bindif -vsname virtual_server_name -ssid spinserver -ifname interface_name

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Bind Network Interface command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Bind Network Interface.

Description

The vservers servers bindif command identifies a interface by its SpinServer and interface name and binds the virtual interface to a virtual server.

Options

-vsname virtual_server_name

This is the name of the virtual server.

-ssid spinserver

This is name of the SpinServer.

-ifname interface_name

This is the name given to the interface.

Example

The following command example identifies a virtual server named Server1vserver1 on a SpinServer named Server1 and binds a virtual interface named Server1interface1 to it.

spinserver::> vservers servers bindif -vsname Server1vserver1 -ssid Server1 -ifname Server1interface1

vservers servers delete

Name

vservers servers delete -- Use the vservers servers delete command to remove a virtual server from the network.

Synopsis

CLI:

vservers servers delete -vsname virtual_server_name

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Delete command from the drop-down menu of the action pane.

Description

The vservers server delete command identifies a virtual server by its name and removes it from the network.

Note: Using the vservers servers delete command deletes all the virtual file systems associated with the virtual server, the network interfaces, and the virtual server itself.

Important: You cannot undo the deletion of virtual file systems, network interfaces, and virtual servers.

Options

-vsname virtual_server_name

This is the name of the virtual server.

Example

The following command example identifies a virtual server named Server1vserver1 and removes it from the network.

spinserver::> vservers servers delete -vsname Server1vserver1

vservers servers modify

Name

vservers servers modify -- Use the vservers servers modify command to modify the configuration of a virtual server.

Synopsis

CLI:

vservers servers modify -vsname virtual_server_name [-spinauth {true | false}] [-floatingsuperuser {true | false}] [-minauth minimum_authentication] [-rulesetname rule_set_name] [-virusscanrwvfs {true | false}] [-virusscanrovfs {true | false}] [-showspinshot {true | false}] [-restrictedacl {true | false}]

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Show command from the drop-down menu of the action pane. Make the appropriate changes in the table that is displayed, then run the Modify command from the drop-down menu.

Description

The vservers servers modify command identifies a virtual server by its name and modifies its minimum authentication level.

Options

-vsname virtual_server_name

This is the name of the virtual server.

[-spinauth {true | false}]

This specifies whether the SpinAuth authentication mechanism is used on the virtual server. The default is false.

[-floatingsuperuser {true | false}]

This specifies whether the virtual server permits a floating superuser. The default is false.

[-minauth minimum_authentication]

This is the minimum authentication level for the virtual server. Possible values are none, cifs-ntlm, cifs-kerberos, and nfs-kerberos.

[-rulesetname rule_set_name]

This specifies the name of a rule set that is to be applied to the virtual server.

[-virusscanrwvfs {true | false}]

This specifies whether virus scanning is enabled on read-write VFSs. The default is false.

[-virusscanrovfs {true | false}]

This specifies whether virus scanning is enabled on read-only VFSs. The default is false.

[-showspinshot {true | false}]

This specifies whether .spinshot directories on the virtual server are visible to clients. The default is false.

[-restrictedacl {true | false}]

This specifies whether CIFS ACLs are used (false) or not used (true) on files on any VFSs that are created on the virtual server. The default is false (that is, ACLs are used). If CIFS ACLs are not used, UNIX mode bits are the only permissions set on files on the VFS, and attempting to modify ACLs from a CIFS client results only in changes to the mode bits.

Example

The following command example identifies a virtual server named Server1vserver1 and changes its minimum authentication level to nfs-kerberos.

spinserver::> vservers servers modify -vsname Server1vserver1 -minauth nfs-kerberos

vservers servers new

Name

vservers servers new -- Use the vservers servers new command to create a virtual server.

Synopsis

CLI:

vservers servers new -vsname virtual_server_name -spdevid storage_pool_ID -spinauth {true | false} -floatingsuperuser {true | false} -minauth minimum_authentication -rulesetname rule_set_name -virusscanrwvfs {true | false} -virusscanrovfs {true | false} -showspinshot {true | false} -restrictedacl {true | false}

GUI: Navigate to the Virtual Servers → Servers node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed, then click Create.

Description

The vservers servers new command creates a virtual server and identifies it by its virtual server name and the name of the storage pool to which it is attached.

Options

-vsname virtual_server_name

This is the name of the virtual server.

-spdevid storage_pool_ID

This is the ID of the storage pool.

-spinauth {true | false}

This specifies whether the SpinAuth authentication mechanism is used on the virtual server. The default is false.

-floatingsuperuser {true | false}

This specifies whether the virtual server permits a floating superuser. The default is false.

-minauth minimum_authentication

This is the minimum authentication level for the virtual server. Possible values are none, cifs-ntlm, cifs-kerberos, and nfs-kerberos.

-rulesetname rule_set_name

This specifies the name of a rule set that is to be applied to the virtual server.

-virusscanrwvfs {true | false}

This specifies whether virus scanning is enabled by default on read-write VFSs. The default is false.

-virusscanrovfs {true | false}

This specifies whether virus scanning is enabled by default on read-only VFSs. The default is false.

-showspinshot {true | false}

This specifies whether .spinshot directories on the virtual server are visible to clients. The default is false.

-restrictedacl {true | false}

This specifies whether CIFS ACLs are used (false) or not used (true) on files on any VFSs that are created on the virtual server. The default is false (that is, ACLs are used). If CIFS ACLs are not used, UNIX mode bits are the only permissions set on files on the VFS, and attempting to modify ACLs from a CIFS client results only in changes to the mode bits.

Example

The following command example creates a new virtual server named Server1vserver1 and attaches it to a storage pool named Server1pool1. The virtual server does not use SpinAuth or permit a floating superuser. The minimum authentication level is specified as nfs-kerberos. A rule set named default_rules is applied to the virtual server. Virus scanning is enabled by default on read-write VFSs but not on read-only VFSs. All .spinshot directories on the virtual server are visible to clients. CIFS ACLs are used on files on new VFSs created on the virtual server.

spinserver::> vservers servers new -vsname Server1vserver1 -spdevid Server1pool1 -spinauth false -floatingsuperuser false -minauth nfs-kerberos -virusscanrwvfs true -virusscanrovfs false -showspinshot true -restrictedacl false

vservers servers newrootmirror

Name

vservers servers newrootmirror -- Use the vservers servers newrootmirror command to create a backup of a virtual server's root.

Synopsis

CLI:

vservers servers newrootmirror -vsname virtual_server_name -sinkvfs sink_VFS_name -sinksp sink_storage_pool

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate virtual server from the table and run the New Root Mirror command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click New Root Mirror.

Description

The vservers servers newrootmirror command creates a backup of a virtual server's root. Unlike other mirror commands, this command does not require the SpinMirror software package.

Options

-vsname virtual_server_name

This is the name of the virtual server whose root is to be mirrored.

-sinkvfs sink_VFS_name

This is the VFS into which the root is to be mirrored.

-sinksp sink_storage_pool

This is the storage pool on which the sink VFS is located.

Example

The following command example mirrors the root of a virtual server named vs0. The root is mirrored to a VFS named repos_vfs_1 on a storage pool named sp2.

spinserver::> vservers servers newrootmirror -vsname vs0 -sinkvfs repos_vfs_1 -sinksp sp2

vservers servers offline

Name

vservers servers offline -- Use the vservers servers offline command to take offline all virtual interfaces bound to a virtual server.

Synopsis

CLI:

vservers servers offline -vsname virtual_server_name

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Offline command from the drop-down menu of the action pane.

Description

The vservers servers offline command identifies a virtual server and takes offline all virtual interfaces bound to it.

Options

-vsname virtual_server_name

This is the name of the virtual server whose virtual interfaces are taken offline.

Example

The following command example identifies a virtual server named Server1vserver1 and takes offline all virtual interfaces bound to it.

spinserver::> vservers servers offline -vsname Server1vserver1

vservers servers online

Name

vservers servers online -- Use the vservers servers online command to bring online all virtual interfaces bound to a virtual server.

Synopsis

CLI:

vservers servers online -vsname virtual_server_name

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table that is displayed and run the Online command from the drop-down menu of the action pane.

Description

The vservers servers online command identifies a virtual server and brings online all virtual interfaces bound to it.

Options

-vsname virtual_server_name

This is the name of the virtual server whose virtual interfaces are brought online.

Example

The following command example identifies a virtual server named Server1vserver1 and brings online all virtual interfaces bound to it.

spinserver::> vservers servers online -vsname Server1vserver1

vservers servers show

Name

vservers servers show -- Use the vservers servers show command to display configuration information about all virtual servers or information about one virtual server.

Synopsis

CLI:

vservers servers show [-vsname virtual_server_name]

GUI: Navigate to the Virtual Servers → Servers node. To display information about a specific server, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The vservers servers show command displays information about one virtual server or all virtual servers. To display information about one virtual server, use the command with the -vsname parameter. To display configuration information about all of the virtual servers in the system, do not use the -vsname parameter. The command displays the following information:

The following additional information is displayed about a specific virtual server:

Options

[-vsname virtual_server_name]

This is the name of the virtual server whose configuration information is displayed by the system.

Example

The following example displays information about all virtual servers:

spinserver::> vservers servers show 
Name             Network Interface        Min Authentication
                                               (NFS Only)

Server1         Server12:Data, Server1:Data    none

The following example identifies a virtual server named vs0 and displays its configuration information.

spinserver::> vservers servers show -vsname vs0
   Name                            vs0
   Storage Pool for Root VFS       pool0
   User Type for root FID          NFS
   Domain of root FID              example.com
   User of root FID                0
   Group of root FID               0
   Network Interfaces              Server12:Data, Server:Data
   Virtual Server ID               15
   Root VFS ID                     5369
   Status                          online (Data,Data)
   Min Authentication              none
   Min Authentication              nfs-kerberos                           
   Export Ruleset Name             default_ruleset                         
   VirusScan for R-W VFS           true                                    
   VirusScan for R-O VFS           true                                    

vservers servers unbindif

Name

vservers servers unbindif -- Use the vservers servers unbindif command to unbind a virtual interface from a virtual server.

Synopsis

CLI:

vservers servers unbindif -vsname virtual_server_name -ssid spinserver -ifname interface_name

GUI: Navigate to the Virtual Servers → Servers node, then select the appropriate server from the table and run the Unbind Network Interface command from the drop-down menu of the action pane.

Description

The vservers servers unbindif command identifies a interface by its server and interface name and unbinds a virtual interface from a virtual server.

Options

-vsname virtual_server

This is the name of the virtual server.

-ssid spinserver

This is the ID given to the SpinServer.

-ifname interface_name

This is the name of the interface.

Example

The following command example identifies interface named Server1interface1 and unbinds it from a virtual server named Server1vserver1 on a SpinServer named Server1.

spinserver::> vservers servers unbindif -vsname Server1vserver1 -ssid Server1 -ifname Server1interface1 

Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.